cr-mdw-ux

(0 reviews)

OTT - Create Entitlement

/{businessId}/product

[POST]

This usecase is to create an subscription for multiple OTTs in Bango or ToolBox systems

URL

https://nonprod.lcr.esb.cloud.lla.com/test/cr-mdw-ux-lcr/cr-mdw-ux/v1/{businessId}/product

URI Params

name	type	description	required
businessId	string	Default CR for Costa Rica	Y

Headers

name	type	description	required
client_id	string	The client_id identifying the channel. Minimum characters: 5	Y
client_secret	string	Password associated with the client_id. Minimum characters: 5	Y
X-Correlation-ID	string	Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction.	Y

Body

Definitions - Bundle

Name	Type	Description	Required
isBundle	Boolean	Indicates whether the product is a bundle (`true` or `false`).	Y
billingAccount.id	string	Unique identifier of the billing account.	Y
billingAccount.contact[].contactType	String	Type of contact associated with the billing account (Example: `primary`).	N
billingAccount.contact[].contactMedium[].characteristic.emailAddress	String	Email address to send the activation link to the customer.	Y
billingAccount.@baseType	String	Base type of the billing account entity. Default: `billingAccount`.	N
billingAccount.@type	String	Type of the billing account entity. Default: `billingAccount`.	N
productSpecification.id	string	product code. Default: `Bundle1234`	Y
productSpecification.name	string	Merchant key associated with the product. Default: `BUNDLE`	Y
productRelationship[].relationshipType	string	Relationship type of the product. Default: `bundled`.	Y
productRelationship[].product.productSpecification.id	string	Disney/Universal/Amazon/Hbo Max product code.	Y
productRelationship[].product.productSpecification.name	string	Merchant key associated with the product (Example: `DISNEY`).	Y
productRelationship[].product.productCharacteristic[].name	string	characteristic for flagEmail to determine whether to send email or not. Default: `flagEmail`	N
productRelationship[].product.productCharacteristic[].value	Boolean	Value of the flagEmail characteristic (`true` or `false`)	N
productRelationship[].product.@baseType	string	Base type of the related product. Default: `Product`.	N
productRelationship[].product.@type	string	Type of the related product. Default: `OTT`.	Y
@baseType	string	Base type of the product. Default: `Product`.	N
@type	string	Type of the product. Default: `OTT`.	Y
realizingResource[].id	string	MSISDN associated with the customer to send notifications to	N
realizingResource[].name	string	Name of the resource. Default: 'MSISDN'	N
realizingResource[].@type	string	Type of the realizing resource. Default: `ResourceRef`.	N
realizingResource[].@baseType	string	Base Type of the realizing resource. Default: `Resource`.	N
realizingResource[].@referredType	string	Referred Type of the realizing resource. Default: `Resource`.	N

Definitions - Amazon Standalone

Name	Type	Description	Required
billingAccount.id	String	Unique identifier of the billing account.	Y
productSpecification.id	String	Amazon Product code.	Y
productSpecification.name	String	Merchant key associated with the product. Default: `Amazon`	Y
@baseType	String	Base type of the entity. Default: `Product`.	N
@type	String	Type of the entity. Default: `OTT`.	Y
relatedParty[].id	String	Email address to send the activation link to the customer.	Y
relatedParty[].@referredType	String	Type of the related party. Default: `Individual`.	Y
realizingResource[].id	string	MSISDN associated with the customer to send notifications to	N
realizingResource[].name	string	Name of the resource. Default: 'MSISDN'	N
realizingResource[].@type	string	Type of the realizing resource. Default: `ResourceRef`.	N
realizingResource[].@baseType	string	Base Type of the realizing resource. Default: `Resource`.	N
realizingResource[].@referredType	string	Referred Type of the realizing resource. Default: `Resource`.	N

Definitions - Universal Standalone

Name	Type	Description	Required
billingAccount.id	String	Unique identifier of the billing account.	Y
productSpecification.id	String	Universal Product code.	Y
productSpecification.name	String	Merchant key associated with the product. Default: `Universal`	Y
@baseType	String	Base type of the entity. Default: `Product`.	N
@type	String	Type of the entity. Default: `OTT`.	Y
relatedParty[].id	String	Email address to send the activation link to the customer.	Y
relatedParty[].@referredType	String	Type of the related party. Default: `Individual`.	Y

Definitions - Disney Standalone

Name	Type	Description	Required
productSpecification.id	String	Disney Product code.	Y
productSpecification.name	String	Display name of the product specification (Example: `30 days Disney Plus`).	Y
@baseType	String	Base type of the entity. Default: `Product`.	Y
@type	String	Type of the entity. Default: `OTT`.	Y
@referredType	String	Deprecated. Previously used to identify the merchant type (Example: `DISNEY`). This field will no longer be used in new implementations.	N
billingAccount.id	String	Unique identifier of the billing account.	Y
billingAccount.contact[].contactType	String	Type of contact associated with the billing account (Example: `primary`).	N
billingAccount.contact[].contactMedium[].characteristic.emailAddress	String	Email address to send the activation link to the customer.	Y
billingAccount.@baseType	String	Base type of the billing account entity. Default: `billingAccount`.	N
billingAccount.@type	String	Type of the billing account entity. Default: `billingAccount`.	N

Definitions - HBO Max Standalone

Name	Type	Description	Required
isBundle	Boolean	Indicates whether the product is a bundle (`true` or `false`).	Y
billingAccount.id	String	Unique identifier of the billing account.	Y
billingAccount.contact[].contactType	String	Type of contact associated with the billing account (Example: `primary`).	N
billingAccount.contact[].contactMedium[].characteristic.emailAddress	String	Email address to send the activation link to the customer.	N
billingAccount.@baseType	String	Base type of the billing account entity. Default: `billingAccount`.	N
billingAccount.@type	String	Type of the billing account entity. Default: `billingAccount`.	N
productSpecification.id	String	HBO Max Product code.	Y
productSpecification.name	String	Merchant key associated with the product.	Y
productCharacteristic[].name	string	characteristic for flagEmail to determine whether to send email or not. Default: `flagEmail`	N
productCharacteristic[].value	Boolean	Value of the flagEmail characteristic (`true` or `false`)	N
@baseType	String	Base type of the entity. Default: `Product`.	N
@type	String	Type of the entity. Default: `OTT`.	Y
realizingResource[].id	string	MSISDN associated with the customer to send notifications to	N
realizingResource[].name	string	Name of the resource. Default: 'MSISDN'	N
realizingResource[].@type	string	Type of the realizing resource. Default: `ResourceRef`.	N
realizingResource[].@baseType	string	Base Type of the realizing resource. Default: `Resource`.	N
realizingResource[].@referredType	string	Referred Type of the realizing resource. Default: `Resource`.	N

Note:

The usage of the email address in the field relatedParty.id is deprecated and for all the usecases it is moved to billingAccount.contact[].contactMedium[].characteristic.emailAddress.

cURL request - BUNDLE

curl --location 'https://nonprod.lcr.esb.cloud.lla.com/test/cr-mdw-ux-lcr/cr-mdw-ux/v1/{businessId}/product' \
--header 'X-Correlation-ID: {{$guid}}' \
--header 'client_id: XXXXX' \
--header 'client_secret: XXXXX' \
--header 'Content-Type: application/json' \
--data-raw '{
    "isBundle": true,
    "productSpecification": {
        "id": "Bundle1234",
        "name": "BUNDLE"
    },
    "productRelationship": [
        {
            "relationshipType": "bundled",
            "product": {
                "productSpecification": {
                    "id": "disneyPlus",
                    "name": "DISNEY"
                },
                "@baseType": "Product",
                "@type": "OTT"
            }
        },
        {
            "relationshipType": "bundled",
            "product": {
                "productSpecification": {
                    "id": "universalPlus",
                    "name": "UNIVERSAL"
                },
                "@baseType": "Product",
                "@type": "OTT"
            }
        },
        {
            "relationshipType": "bundled",
            "product": {
                "productSpecification": {
                    "id": "amazonPrime",
                    "name": "AMAZON"
                },
                "@baseType": "Product",
                "@type": "OTT"
            }
        },
        {
            "relationshipType": "bundled",
            "product": {
                "productSpecification": {
                    "id": "HboMax",
                    "name": "HBO"
                },
                "productCharacteristic": [
                    {
                        "name": "flagEmail",
                        "value": false
                    }
                ],
                "@baseType": "Product",
                "@type": "OTT"
            }
        }
    ],
    "@baseType": "Product",
    "@type": "OTT",
    "billingAccount": {
        "id": "1101523732142",
        "contact": [
            {
                "contactType": "primary",
                "contactMedium": [
                    {
                        "characteristic": {
                            "emailAddress": "test@xyz.com"
                        }
                    }
                ]
            }
        ]
    },
    "realizingResource": [
        {
            "id": "12345678",
            "name": "MSISDN",
            "@baseType": "resource",
            "@type": "ResourceRef",
            "@referredType": "resource"
        }
    ]
}'

Response - BUNDLE

{
    "status": "created",
    "isBundle": true,
    "productSpecification": {
        "id": "Bundle1234",
        "name": "BUNDLE"
    },
    "productRelationship": [
        {
            "relationshipType": "bundled",
            "product": {
                "id": "de9792a7-5ce8-45bd-b553-2600a665f275",
                "productSpecification": {
                    "id": "disneyPlus",
                    "name": "DISNEY"
                },
                "productCharacteristic": [
                    {
                        "name": "activationUrl",
                        "value": "https://www.disney.com"
                    }
                ],
                "@baseType": "Product",
                "@type": "OTT"
            }
        },
        {
            "relationshipType": "bundled",
            "product": {
                "id": "af5692a7-5ce8-45bd-b553-2600a665f275",
                "productSpecification": {
                    "id": "universalPlus",
                    "name": "UNIVERSAL"
                },
                "productCharacteristic": [
                    {
                        "name": "activationUrl",
                        "value": "https://www.universal.com"
                    }
                ],
                "@baseType": "Product",
                "@type": "OTT"
            }
        },
        {
            "relationshipType": "bundled",
            "product": {
                "id": "af5692a7-5ce8-45bd-b553-2600a665f275",
                "productSpecification": {
                    "id": "amazonPrime",
                    "name": "AMAZON"
                },
                "productCharacteristic": [
                    {
                        "name": "activationUrl",
                        "value": "https://www.amazon.com"
                    },
                ],
                "@baseType": "Product",
                "@type": "OTT"
            }
        },
        {
            "relationshipType": "bundled",
            "product": {
                "id": "af5692a7-5ce8-45bd-b553-2600a665f275",
                "productSpecification": {
                    "id": "HboMax",
                    "name": "HBO"
                },
                "productCharacteristic": [
                    {
                        "name": "activationUrl",
                        "value": "https://www.hbo.com"
                    },
                    {
                        "name": "flagEmail",
                        "value": false
                    }
                ],
                "@baseType": "Product",
                "@type": "OTT"
            }
        }
    ],
    "@baseType": "Product",
    "@type": "OTT",
    "billingAccount": {
        "id": "1101523732142",
        "contact": [
            {
                "contactType": "primary",
                "contactMedium": [
                    {
                        "characteristic": {
                            "emailAddress": "test@xyz.com"
                        }
                    }
                ]
            }
        ]
    },
    "realizingResource": [
        {
            "id": "12345678",
            "name": "MSISDN",
            "@baseType": "resource",
            "@type": "ResourceRef",
            "@referredType": "resource"
        }
    ]
}

cURL request - HBO Max Standalone

curl --location 'https://nonprod.lcr.esb.cloud.lla.com/test/cr-mdw-ux-lcr/cr-mdw-ux/v1/{businessId}/product' \
--header 'X-Correlation-ID: {{$guid}}' \
--header 'client_id: XXXXX' \
--header 'client_secret: XXXXX' \
--header 'Content-Type:  application/json' \
--data-raw '{
  "isBundle": false,
  "productSpecification": {
    "id": "HboMax",
    "name": "HBO"
  },
  "productCharacteristic":[{
    "name": "flagEmail",
    "value": true
  }],
  "@baseType": "Product",
  "@type": "OTT",
  "billingAccount": {
        "id": "1101523732142",
        "contact": [
            {
                "contactType": "primary",
                "contactMedium": [
                    {
                        "characteristic": {
                            "emailAddress": "test@xyz.com"
                        }
                    }
                ]
            }
        ]
    },
  "realizingResource": [
    {
      "id": "12345678",
      "name": "MSISDN",
      "@baseType": "Resource",
      "@type": "ResourceRef",
      "@referredType": "Resource"
    }
  ]
}'

Response - HBO Max Standalone

{
    "id": "g8o8ebd6-02f7-4d3f-942e-904344e8cde5",
    "status": "created",
    "isBundle": false,
    "productSpecification": {
        "id": "HboMax",
        "name": "HBO"
    },
    "productCharacteristic": [
        {
            "name": "activationUrl",
            "value": "https://www.hbo.com"
        },
        {
            "name": "flagEmail",
            "value": true
        }
    ],
    "@baseType": "Product",
    "@type": "OTT",
    "billingAccount": {
        "id": "1101523732142",
        "contact": [
            {
                "contactType": "primary",
                "contactMedium": [
                    {
                        "characteristic": {
                            "emailAddress": "test@xyz.com"
                        }
                    }
                ]
            }
        ]
    },
    "realizingResource": [
        {
            "id": "12345678",
            "name": "MSISDN",
            "@baseType": "Resource",
            "@type": "ResourceRef",
            "@referredType": "Resource"
        }
    ]
}

cURL request - Amazon Standalone

curl --location 'https://nonprod.lcr.esb.cloud.lla.com/test/cr-mdw-ux-lcr/cr-mdw-ux/v1/{businessId}/product' \
--header 'X-Correlation-ID: {{$guid}}' \
--header 'client_id: XXXXX' \
--header 'client_secret: XXXXX' \
--header 'Content-Type:  application/json' \
--data-raw '{
  "isBundle": false,
  "productSpecification": {
    "id": "amazonPrime",
    "name": "AMAZON"
  },
  "@baseType": "Product",
  "@type": "OTT",
  "billingAccount": {
    "id": "1101523732142"
  },
  "relatedParty": [
    {
      "id": "test@xyz.com",
      "@referredType": "Individual"
    }
  ],
  "realizingResource": [
    {
      "id": "12345678",
      "name": "MSISDN",
      "@baseType": "resource",
      "@type": "ResourceRef",
      "@referredType": "resource"
    }
  ]
}'

Response - Amazon Standalone

{
    "id": "g8o8ebd6-02f7-4d3f-942e-904344e8cde5",
    "status": "created",
    "isBundle": false,
    "productSpecification": {
        "id": "amazonPrime",
        "name": "AMAZON"
    },
    "productCharacteristic": [
        {
            "name": "activationUrl",
            "value": "https://www.amazon.com"
        }
    ],
    "@baseType": "Product",
    "@type": "OTT",
    "billingAccount": {
        "id": "1101523732142"
    },
    "relatedParty": [
        {
            "id": "test@xyz.com",
            "@referredType": "Individual"
        }
    ],
    "realizingResource": [
        {
            "id": "12345678",
            "name": "MSISDN",
            "@baseType": "resource",
            "@type": "ResourceRef",
            "@referredType": "resource"
        }
    ]
}

cURL request - Univaersal Standalone

curl --location 'https://nonprod.lcr.esb.cloud.lla.com/test/cr-mdw-ux-lcr/cr-mdw-ux/v1/{businessId}/product' \
--header 'X-Correlation-ID: {{$guid}}' \
--header 'client_id: XXXXX' \
--header 'client_secret: XXXXX' \
--header 'Content-Type:  application/json' \
--data-raw '{
  "isBundle": false,
  "productSpecification": {
    "id": "UniversalPlus",
    "name": "UNIVERSAL"
  },
  "@baseType": "Product",
  "@type": "OTT",
  "billingAccount": {
    "id": "1101523732142"
  },
  "relatedParty": [
    {
      "id": "test@xyz.com",
      "@referredType": "Individual"
    }
  ]
}'

Response - Universal Standalone

{
    "isBundle": false,
    "productSpecification": {
        "id": "UniversalPlus",
        "name": "UNIVERSAL"
    },
    "productCharacteristic": [
        {
            "name": "activationUrl",
            "value": "https://www.universal.com"
        }
    ],
    "@baseType": "Product",
    "@type": "OTT",
    "billingAccount": {
        "id": "1101523732142"
    },
    "relatedParty": [
        {
            "id": "test@xyz.com",
            "@referredType": "Individual"
        }
    ]
}

cURL request - Disney Standalone

curl --location 'https://nonprod.lcr.esb.cloud.lla.com/test/cr-mdw-ux-lcr/cr-mdw-ux/v1/{businessId}/product' \
--header 'X-Correlation-ID: {{$guid}}' \
--header 'client_id: XXXXX' \
--header 'client_secret: XXXXX' \
--header 'Content-Type:  application/json' \
--data-raw '
{
    "productSpecification": {
        "id": "disneyPlus",
        "name": "30 days Disney Plus"
    },
    "@baseType": "Product",
    "@type": "OTT",
    "@referredType": "DISNEY",
    "billingAccount": {
        "id": "1101523732142",
        "contact": [
            {
                "contactType": "primary",
                "contactMedium": [
                    {
                        "characteristic": {
                            "emailAddress": "test@xyz.com"
                        }
                    }
                ]
            }
        ],
        "@baseType": "billingAccount",
        "@type": "billingAccount"
    }
}'

Response - Disney Standalone

{
    "id": "g8o8ebd6-02f7-4d3f-942e-904344e8cde5",
    "status": "created",
    "productSpecification": {
        "id": "disneyPlus",
        "name": "30 days Disney Plus"
    },
    "productCharacteristic": [
        {
            "name": "activationUrl",
            "value": "https://www.disney.com"
        }
    ],
    "@baseType": "Product",
    "@type": "OTT",
    "@referredType": "DISNEY",
    "billingAccount": {
        "id": "1101523732142",
        "contact": [
            {
                "contactType": "primary",
                "contactMedium": [
                    {
                        "characteristic": {
                            "emailAddress": "test@xyz.com"
                        }
                    }
                ]
            }
        ],
        "@baseType": "billingAccount",
        "@type": "billingAccount"
    }
}